<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>rdebug: common_schema documentation</title>
	<meta name="description" content="rdebug: common_schema" />
	<meta name="keywords" content="rdebug: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="rdebug.html">rdebug</a></h2>	

<h3>rdebug is a debugger and a debugging API for MySQL stored routines</h3>

<p>
	<strong>rdebug</strong></a> is a pure SQL, server side debugging framework. Relying on
	stored routines themselves, it allows for debugging of MySQL stored routines.
</p>
<p>
	<i>rdebug</i> provides with an <a href="rdebug_api.html">API</a> that can be used by
	all clients - from command line sessions to GUI tools. The API is based on stored
	routine calls.
</p>

<p>
	<i>rdebug</i> works by running two MySQL sessions: the <strong>worker</strong> session,
	where one issues her stored routine, and the <strong>debugger</strong> session, which
	attaches to the <i>worker</i> session and controls it.
</p>
<p>
	<i>rdebug</i> relies on code injection: one must compile his stored procedure in 
	<i>debug mode</i> so as to debug it. This process injects <i>rdebug</i> specific code
	into the routine. This code can later be removed by compiling the routine again,
	this time without debug info.
</p>
<p>
	See <a href="rdebug_workflow.html">rdebug workflow</a> to find out how to set up and work out
	a debugging session.
</p>
<p>
	<i>rdebug</i> is in <strong>alpha</strong> - experimental - stage. It provides with
	working functionality, with some known limitations.
</p>

<p>
Known limitations in <i>rdebug - alpha</i>:
<ul>
	<li>Debugging limited to stored procedures. Support for stored functions is expected.
		Support for triggers and events is not expected.
	</li>
	<li>
		Conditional breakpoints (i.e. breakpoint where some condition holds true) 
		are not yet supported
	</li>
	<li>
		At this stage, breakpoints are declared per debugging session. Thus, a breakpoint
		set by one debugger will not exist on a simultaneous second debugger. This design
		is being reviewed and is subject to change.
	</li>
	<li><a href="rdebug_run.html">rdebug_run()</a> is known to hang when
		the entire routine executes without at least once stopping on a breakpoint
		or on a <i>step</i>.
	</li>
	<li>
		Importing <i>common_schema</i> will terminate any running debugging session
		(though will not interfere with the execution of the <i>worker</i>). 
	</li>
</ul>
</p>

<h3>SEE ALSO</h3>
<a href="query_script.html">Query Script</a>,
<a href="rdebug_api.html">rdebug API</a>

<h3>AUTHOR</h3>
Shlomi Noach

				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
